<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>tmrctr: xtmrctr_fast_intr_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">tmrctr
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xtmrctr__fast__intr__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xtmrctr_fast_intr_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the timer counter driver (XTmCtr) and hardware device using fast interrupt mode.This example assumes that the interrupt controller is also present as a part of the system. </p>
<pre>
 MODIFICATION HISTORY:</pre><pre> Ver   Who  Date         Changes
</p>
<hr/>
<p>
 1.00a bss  07/31/12 First release
 4.2   ms   01/23/17 Added xil_printf statement in main function to
                     ensure that "Successfully ran" and "Failed" strings
                     are available in all examples. This is a fix for
                     CR-965028.
 4.5   mus  07/05/18 Updated example to call TmrCtrDisableIntr function
                     with correct arguments. Presently device id is
                     being passed instead of interrupt id. It fixes
                     CR#1006251.
 4.5   mus  07/05/18 Fixed checkpatch errors and warnings.
 4.12  ml   12/07/23 Make TimerExpired as a static variable.
 4.12  mus  03/25/24 Update RESET_VALUE to reduce extecution time to 1 seconds.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a158edad62d84952adab7646dbdd52a36"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtmrctr__fast__intr__example_8c.html#a158edad62d84952adab7646dbdd52a36">TmrCtrFastIntrExample</a> (XIntc *IntcInstancePtr, <a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *TmrCtrInstancePtr, u16 DeviceId, u16 IntrId, u8 TmrCtrNumber)</td></tr>
<tr class="memdesc:a158edad62d84952adab7646dbdd52a36"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does a minimal test on the timer counter device and driver as a design example.  <a href="#a158edad62d84952adab7646dbdd52a36">More...</a><br/></td></tr>
<tr class="separator:a158edad62d84952adab7646dbdd52a36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa0cce7d285718e72442102d4bf56e5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtmrctr__fast__intr__example_8c.html#afa0cce7d285718e72442102d4bf56e5a">TimerCounterHandler</a> (void *CallBackRef, u8 TmrCtrNumber)</td></tr>
<tr class="memdesc:afa0cce7d285718e72442102d4bf56e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the handler which performs processing for the timer counter.  <a href="#afa0cce7d285718e72442102d4bf56e5a">More...</a><br/></td></tr>
<tr class="separator:afa0cce7d285718e72442102d4bf56e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="afa0cce7d285718e72442102d4bf56e5a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void TimerCounterHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>TmrCtrNumber</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the handler which performs processing for the timer counter. </p>
<p>It is called from an interrupt context such that the amount of processing performed should be minimized. It is called when the timer counter expires if interrupts are enabled.</p>
<p>This handler provides an example of how to handle timer counter interrupts but is application specific.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is a pointer to the callback function </td></tr>
    <tr><td class="paramname">TmrCtrNumber</td><td>is the number of the timer to which this handler is associated with.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<p>It is called from an interrupt context.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is a pointer to the callback function </td></tr>
    <tr><td class="paramname">TmrCtrNumber</td><td>is the number of the timer to which this handler is associated with.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group___overview.html#ga44d19561a31682753e4996c7b57d6982">XTmrCtr_IsExpired()</a>, and <a class="el" href="group___overview.html#ga93d796cf55144d6adb3c51fedf6c3b76">XTmrCtr_SetOptions()</a>.</p>

<p>Referenced by <a class="el" href="xtmrctr__intr__64bit__example_8c.html#a232646e3ad3fc178f3ffb78c3b3584ec">TmrCtrCascadeIntrExample()</a>, <a class="el" href="xtmrctr__fast__intr__example_8c.html#a158edad62d84952adab7646dbdd52a36">TmrCtrFastIntrExample()</a>, <a class="el" href="xtmrctr__intr__example_8c.html#a5d61a920b9e37a9d8c2241c0e749992d">TmrCtrIntrExample()</a>, and <a class="el" href="xtmrctr__pwm__example_8c.html#afbddd81bc7587f883bc7e4b77a850c34">TmrCtrPwmExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a158edad62d84952adab7646dbdd52a36"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int TmrCtrFastIntrExample </td>
          <td>(</td>
          <td class="paramtype">XIntc *&#160;</td>
          <td class="paramname"><em>IntcInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *&#160;</td>
          <td class="paramname"><em>TmrCtrInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>IntrId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>TmrCtrNumber</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function does a minimal test on the timer counter device and driver as a design example. </p>
<p>The purpose of this function is to illustrate how to use the <a class="el" href="struct_x_tmr_ctr.html" title="The XTmrCtr driver instance data. ">XTmrCtr</a> component. It initializes a timer counter and then sets it up in compare mode with auto reload such that a periodic interrupt is generated.</p>
<p>This function uses interrupt driven mode of the timer counter.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IntcInstancePtr</td><td>is a pointer to the Interrupt Controller driver Instance </td></tr>
    <tr><td class="paramname">TmrCtrInstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_tmr_ctr.html" title="The XTmrCtr driver instance data. ">XTmrCtr</a> driver Instance </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is the XPAR_&lt;TmrCtr_instance&gt;_DEVICE_ID value from xparameters.h </td></tr>
    <tr><td class="paramname">IntrId</td><td>is XPAR_&lt;INTC_instance&gt;_&lt;TmrCtr_instance&gt;_VEC_ID value from xparameters.h </td></tr>
    <tr><td class="paramname">TmrCtrNumber</td><td>is the number of the timer to which this handler is associated with.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the Test is successful</li>
<li>XST_FAILURE if the Test is not successful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function contains an infinite loop such that if interrupts are not working it may never return. </dd></dl>

<p>References <a class="el" href="struct_x_tmr_ctr.html#a1fc51ca5db0c37e2b9b8db794f8a7496">XTmrCtr::Config</a>, <a class="el" href="xtmrctr__fast__intr__example_8c.html#afa0cce7d285718e72442102d4bf56e5a">TimerCounterHandler()</a>, <a class="el" href="group___overview.html#gad5f9b6172f448d2dd13d1c200ca37928">XTmrCtr_Initialize()</a>, <a class="el" href="group___overview.html#ga42b972b6d7ae5d18a9bb2ca99446b1e7">XTmrCtr_SelfTest()</a>, <a class="el" href="group___overview.html#ga9eb7b372c13b5e3493fec7370858309f">XTmrCtr_SetHandler()</a>, <a class="el" href="group___overview.html#ga93d796cf55144d6adb3c51fedf6c3b76">XTmrCtr_SetOptions()</a>, <a class="el" href="group___overview.html#ga74b790866611a3ab1e96700feb48f6ea">XTmrCtr_SetResetValue()</a>, <a class="el" href="group___overview.html#ga009c17ab4fcedf73279638dd97b6edd4">XTmrCtr_Start()</a>, and <a class="el" href="group___overview.html#gab8156ff2a16b8efc0fcd3ed2b7ecf91a">XTmrCtr_Stop()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
